Favicon

You are here: Home > API Reference > Apple > Apple Policies > List Apple device policies

List Apple device policies

Required Permission: mdm.apple.policy.list

Retrieves a paginated list of Apple device policies configured for the organization.

GET
https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/policies 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/policies" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/policies", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const data = await response.json();
import requests

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/policies",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

page integer
optional
Sequential page index for navigating large datasets, enabling systematic access to specific record subsets within the total collection.
limit integer
optional
Maximum number of records returned per request to control data density, optimize interface performance, and manage payload size
sort string
optional
Ordering criteria using a field-to-direction mapping to organize results based on specific attributes like creation date, name, or status.
Match pattern: ^[\w.]*((:asc)|(:desc))?$
name string
optional
Human-readable policy name displayed in dashboard for administrative identification and organizational purposes throughout device management.
≤ 256 characters
targetType string
optional
Policy application scope defining whether configurations apply to entire device or device user context only.
devicedeviceUser
segmentId integer
optional
Segment identifier for scoping policy into an specific segment
expandTo string
optional
Param to include ancestor or child related entities
ancestorschildren

Responses

200 Response application/json
status boolean optional
data object optional
items array [object] optional
id string optional
Unique Apple device policy identifier used to track configuration rules and security settings throughout lifecycle.
Match pattern: ^[a-fA-F0-9]{24}$
organization string optional
Organization identifier owning this Apple device policy and managing enrolled iOS iPadOS and macOS devices.
Match pattern: ^[a-fA-F0-9]{24}$
admEnterprise string optional
Apple enterprise account identifier linked to Apple Business Manager or Apple School Manager for device management.
Match pattern: ^[a-fA-F0-9]{24}$
targetType string optional
Policy application scope defining whether configurations apply to entire device or device user context only.
device deviceUser
attachedProfile object optional
Automatically attached configuration profile containing essential MDM settings applied independently of policy assignments and priorities.
name string optional
Human-readable policy name displayed in dashboard for administrative identification and organizational purposes throughout device management.
≤ 256 characters
profiles array [object] optional
List of Apple configuration profiles containing device restrictions security settings and feature configurations applied by policy.
applications array [object] optional
List of application assignments defining managed apps with VPP licensing installation actions and configuration settings.
applicationsInfo array [object] optional
Enriched application metadata including app names icons versions and store information for dashboard display purposes.
books array [object] optional
List of book assignments for distributing VPP-purchased books or PDF documents to managed Apple devices.
booksInfo array [object] optional
Enriched book metadata including titles authors cover images and store information for dashboard display purposes.
scripts array [object] optional
List of script assignments for executing automated tasks compliance checks and configuration enforcement on macOS devices.
scriptsInfo array [object] optional
Enriched script metadata including execution history last run timestamps and success rates for monitoring purposes.
bookmarks array [object] optional
List of bookmark assignments for deploying web application shortcuts and internal portal links to device home screens.
assets array [object] optional
List of asset assignments for deploying files certificates configuration data and resources to managed macOS devices.
assetsInfo array [object] optional
Enriched asset metadata including file sizes deployment status and version information for monitoring and auditing purposes.
version integer optional
Policy version number incremented with each modification for tracking configuration changes and rollback capabilities.
≥ 0
updatedAt string optional
ISO timestamp of last policy modification for change tracking synchronization and audit trail purposes.
Format: date-time
createdAt string optional
ISO timestamp when policy was created in system for lifecycle tracking and compliance reporting purposes.
Format: date-time
agentConfiguration object optional
MDM agent behavior settings controlling location tracking app monitoring data collection and application enforcement actions.
segmentId integer optional
Segment identifier for scoping policy into an specific segment
≥ 0
exposeToChildren boolean optional
totalDocs integer optional
limit integer optional
hasPrevPage boolean optional
hasNextPage boolean optional
page integer optional
totalPages integer optional
prevPage integer optional
nextPage integer optional
lean boolean optional 
{
    "status": true,
    "data": {
        "items": [
            {
                "id": "698f41b2457fafa13d088793",
                "organization": "598f469d457fafa13d088795",
                "admEnterprise": "698f42e5457fafa13d088794",
                "targetType": "device",
                "attachedProfile": {},
                "name": "Corporate Security Policy - iOS",
                "profiles": [
                    {
                        "id": "string",
                        "organization": "string",
                        "admEnterprise": "string",
                        "admPolicy": "string",
                        "targetType": "device",
                        "name": "string",
                        "config": {},
                        "certificates": [
                            {
                                "mdmAssetId": "string",
                                "format": {
                                    "uuid": "uuid",
                                    "base64": "base64"
                                },
                                "location": "string",
                                "password": "string",
                                "allowAllAppsAccess": true,
                                "keyIsExtractable": true
                            }
                        ],
                        "type": "attached",
                        "UUID": "string",
                        "version": 0,
                        "updatedAt": "2024-01-01T00: 00:00Z",
                        "createdAt": "2024-01-01T00: 00:00Z",
                        "assignedTo": {
                            "policies": [
                                {
                                    "id": "string",
                                    "name": "string"
                                }
                            ],
                            "devices": [
                                {
                                    "id": "string",
                                    "displayName": "string"
                                }
                            ]
                        },
                        "useCustomFileVaultCertificates": true,
                        "parentAdmProfileId": "string"
                    }
                ],
                "applications": [
                    {
                        "admApplication": "698f42e5457fafa13d088794",
                        "managed": true,
                        "managementFlags": 5,
                        "vpp": true,
                        "iOSApp": true,
                        "configuration": {},
                        "action": "forceInstall",
                        "actionStatus": "forceInstall",
                        "scripts": {},
                        "updatePolicy": {}
                    }
                ],
                "applicationsInfo": [
                    {}
                ],
                "books": [
                    {
                        "type": "asset",
                        "id": "698f42e5457fafa13d088794"
                    }
                ],
                "booksInfo": [
                    {}
                ],
                "scripts": [
                    {
                        "type": "loop",
                        "id": "698f42e5457fafa13d088794",
                        "loopTime": 3600,
                        "arguments": "--verbose --check-compliance",
                        "name": "Security Compliance Check",
                        "description": "Validates device security posture against organizational standards",
                        "runner": "bash"
                    }
                ],
                "scriptsInfo": [
                    {}
                ],
                "bookmarks": [
                    {
                        "title": "Employee Portal",
                        "description": "Internal employee self-service portal",
                        "url": "https://portal.company.com",
                        "iconBase64": "",
                        "iconUrl": "https://portal.company.com/icon.png"
                    }
                ],
                "assets": [
                    {
                        "mdmAssetId": "698f41b2457fafa13d088793",
                        "location": "/Library/Application Support/Company/config.json",
                        "assetName": "App Configuration",
                        "scope": "system"
                    }
                ],
                "assetsInfo": [
                    {}
                ],
                "version": 3,
                "updatedAt": "2026-02-13T14: 30:00Z",
                "createdAt": "2026-02-13T10: 00:00Z",
                "agentConfiguration": {
                    "allowLocation": true,
                    "allowLocationMacos": true,
                    "allowPackageTime": true,
                    "allowPackageTimeIos": true,
                    "allowPackageTransfer": true,
                    "allowPackageTransferIos": true,
                    "allowDeviceInfoBatteryUsage": true,
                    "allowDeviceInfoBluetooth": true,
                    "allowDeviceInfoSystemInfo": true,
                    "allowDeviceInfoBatteryUsageIos": true,
                    "allowDeviceInfoBluetoothIos": true,
                    "allowDeviceInfoSystemInfoIos": true,
                    "allowNetworkStatusMacos": true,
                    "allowNetworkStatusIos": true,
                    "appBlacklist": [
                        {
                            "bundleId": "com.example.unauthorized",
                            "action": "block"
                        }
                    ],
                    "policyFeatures": {
                        "ios": {
                            "defaultViewFeature": "applications",
                            "toggledFeatures": [
                                {
                                    "name": "applications",
                                    "active": true
                                }
                            ],
                            "enableDefaultView": true
                        },
                        "macos": {
                            "defaultViewFeature": "applications",
                            "toggledFeatures": [
                                {
                                    "name": "applications",
                                    "active": true
                                }
                            ],
                            "enableDefaultView": true
                        }
                    }
                },
                "segmentId": "1",
                "exposeToChildren": true
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0,
        "lean": true
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}